chore: prepare for repository split#595
Conversation
jahn-junior
requested review from
SecondSkoll,
akcano,
dwilding,
medubelko,
minaelee,
rkratky and
tang-mm
as code owners
jahn-junior
changed the title
jahn-junior
changed the title
medubelko
left a comment
medubelko
left a comment
There was a problem hiding this comment.
- I left a few general comments. We could invest significant effort in improving the comments, but I don't know if we have the time.
- Where do we stand with changelog vs. release notes in the code?
jahn-junior
changed the title
jahn-junior
left a comment
jahn-junior
left a comment
There was a problem hiding this comment.
I left a few general comments. We could invest significant effort in improving the comments, but I don't know if we have the time.
Let's come back to this for https://github.com/canonical/sphinx-docs-starter-pack/issues/488.
Where do we stand with changelog vs. release notes in the code?
Since the changelog is relied on by the upgrade script, it has to stay put. Instead of leaving the release notes somewhere in the repository, I'd rather rely on the GitHub releases.
a-velasco
left a comment
a-velasco
left a comment
There was a problem hiding this comment.
Read through the conf.py, and tried adding new docs to an existing project with this branch. Everything works as expected locally.
I also tested your branch (work/rename-and-format) in the sphinx-stack-docs repo and browsed through the edited docs. I only saw one thing I'd like to see tweaked before merging it (I left a comment on the commit, and in the process learned that you can apparently leave comments in random commits).
a-velasco
left a comment
a-velasco
left a comment
There was a problem hiding this comment.
Thank you for this absolutely massive effort 🎉 Truly worthy of a major version update.
medubelko
left a comment
medubelko
left a comment
There was a problem hiding this comment.
Looks good and tests good.
One parting thought. This is what the template builds to:
WDYT about:
It might make the placeholders more consistent + obvious.
|
Removed documentation pages are redirected through RTD to a new repo and domain. |
3 participants
CHANGELOG.mdwith relevant non-documentation file changes?Overview
By separating the documentation from the template itself, we simplify the process of boostrapping and maintaining docs projects for our users. The docs need to be deleted in new projects and prevent users from merging in changes from the Starter Pack as an upstream remote. They also have no way to differentiate between core Starter Pack elements and extra configuration needed for its docs, which leads to lots of bloat ending up in downstream projects.
This PR removes the Starter Pack docs from this repository. After this is merged and announced, documentation will be maintained in https://github.com/canonical/starter-pack-docs (name not finalized).
Project-specific configuration values have been replaced with null values. Any values that aren't commonly changed were left with reasonable defaults. I also took a lot of whitespace out of the configuration file and tweaked some of the TODOs.
Note for reviewers
Review these changes: The diff is nearly all deletions. I recommend skipping to the
conf.pyfile in the diff, as that has the most subjective changes. To check the repository structure, it'll be easiest to look at my branch directly to check the structure.Review the Sphinx Stack documentation repository: I think the best option here is to check out my branch, build it locally, and do a quick safety check on the rendered pages. No sneaky changes—just the rename and source formatting.